home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / clasfy14.zip / CLASSIFY.DOC < prev    next >
Text File  |  1992-08-08  |  19KB  |  429 lines
  1.  
  2.                              CLASSIFIED ADS
  3.  
  4.                                   v1.4
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    The CLASSIFIED Ads Door allows your callers to post classified ads in up to
  21.    15 different categories. The categories are defined by you, the Sysop, along
  22.    with the number of days you want the ads to be active. A maintenance program,
  23.    that runs at night in your event, will handle the purging automatically.
  24.  
  25.    Note: There is no limitation to the number of classified ads you can have in
  26.          the database, provided you are running a registered version.
  27.          Unregistered version allows for 20 ads.
  28.          
  29.  
  30.  
  31.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  32.          created in the directory you run the door from.
  33.  
  34.  
  35.  
  36.                               INSTALLATION
  37.                               ____________
  38.  
  39.  
  40.    Installation is fairly easy and straight-forward. The following steps and
  41.    examples should have you up and running in a very short period of time.
  42.    It is assumed that you are familiar with setting up DOORS on your system.
  43.    To this end, only examples of the configuration file and Door batch file
  44.    are described.
  45.  
  46.       1) Create a directory to hold all CLASSIFY files
  47.  
  48.       2) Unzip CLASFYxx.ZIP into the the above directory
  49.  
  50.          NOTE: BRUN45.EXE is not included but is required !!!
  51.  
  52.       3) Create a configuration file, with a name of your choice, or
  53.          modify the supplied CLASSIFY.CFG file. A description follows:
  54.  
  55.             **                       Location of system file (See Below)
  56.             SUNRISE-80 BBS           Your BBS Name
  57.             Al                       Sysop's First nameAP
  58.  
  59.             Lawrence                 Sysop's Last Name
  60. |-----------------------------------------------------------------------------|
  61. | READ!     1                        CommPort  \ These 2 lines are required   |
  62. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  63. |-----------------------------------------------------------------------------|
  64.  
  65.             00000000                 Registration Number
  66.  
  67.         #   2                        1 = DO NOT Display ADOPT-A-DOOR Message
  68.                                      2 = Display ADOPT-A-DOOR message
  69.  
  70.         #   2                        Keyboard timeout value in Minutes
  71.  
  72.  
  73.         #   NONE                     Drive:\Path\Filename to contain the
  74.                                      Bulletin summarizing all classified
  75.                                      ads in the database.
  76.  
  77.             Y                        Y=Display the Originating BBS Name
  78.                                      N=Do Not Display the Originating BBS Name
  79.  
  80.             N                        Y =  Use European Date Format (DDMMYY)
  81.                                      N =  Use Regular  Date Format (MMDDYY)
  82.  
  83.          #  0                        Minimum Logon Security Level required to
  84.                                      enter a new AD option. Zero(0) will 
  85.                                      allow access to everyone.
  86.  
  87.          #  0                        Minimum Logon Security Level required to
  88.                                      access the DELETE option. Zero(0) will 
  89.                                      allow access to everyone.
  90.  
  91.          #  0                        Minimum Logon Security Level required to
  92.                                      access the MODIFY option. Zero(0) will 
  93.                                      allow access to everyone.
  94.  
  95.             00000000                 Ads Exchange Program Registration Number
  96.      
  97.               ** = Replace with ONE of the following:
  98.  
  99. C:\BBS\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  100. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  101. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  102.                                    (Note:DOOR.SYS must be in SAME directory)
  103. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  104. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  105. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  106. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  107. C:\BBS\GTUSER.BBS               <- For GT Power 
  108.                                    * if using this option you must put the
  109.                                      ComPort # on line 5 and the Node # on
  110.                                      line 6 of the configuration file
  111.  
  112.  
  113.  
  114.            # = Requires registration to change to a different value.
  115.  
  116.                NOTE: There are NO Blank Lines in the Config File!!
  117.  
  118.  
  119.  
  120.  
  121.       4) Create a batch file or modify the CLASSIFY file supplied. A
  122.          description of this file follows:
  123.  
  124.             ECHO off
  125.             cd\BBS\DOORS\CLASSIFY     Location of CLASSIFY files
  126.             CLASSIFY CLASSIFY.CFG     EXE filename and CFG filename (Name
  127.                                       used in creating file in #3 above)
  128.             CD\BBS
  129.             BOARD
  130.  
  131.  
  132.        5) When running in more than one node, be sure to supply a
  133.           different configuration name for each node (your choice of name).
  134.  
  135.  
  136.  
  137.  
  138.                         CATEGORY FILE (Classify.CAT)
  139.                         ----------------------------
  140.  
  141.        Be sure to give a lot of thought to your choice of categories, since
  142.        the category position in this file is carried in each Ad record. This
  143.        means, if you set up the categories so that #2 was 'Want Ads - General'
  144.        and the caller entered an Ad under that category, the Ad would carry
  145.        category #2 as the category number. If you then decide that you want to
  146.        change the 'Want Ad - General' category to say, 'Announcements', then 
  147.        the Ads carrying #2 in their record would be classified incorrectly.
  148.  
  149.                The format of the Category.Dat file follows:
  150.  
  151.                               wwwwwwww,xx,y,z
  152.  
  153.                Where w = Category name. Max length: 25 characters
  154.                      x = Number of days to remain active. Min:1 Max 365
  155.                      y = Should the program ask for COST ($$$) info. You
  156.                          would answer Y for a For Sale type category and
  157.                          an N for a WANT AD or Announcment type category.
  158.                      z = Category security level. If caller's logon security
  159.                          level is less than this security level, they will not
  160.                          be able to enter or view an ad in this category. A
  161.                          category security level of 0 allows anyone access.
  162.  
  163.           NOTE: Maximum number of entries is 34.
  164.                 Unregistered version can not change the supplied version
  165.                 of the Category.Dat file.
  166.  
  167.  
  168.                         WELCOME and GOODBYE Files
  169.                         -------------------------
  170.       The following applies to registered versions of CLASSIFY ONLY!
  171.  
  172.       If the program finds a file called WELCOME, it will display that file 
  173.       after the opening screen and before the main menu screens. WELCOME must
  174.       reside in the same directory as CLASSIFY.EXE
  175.  
  176.       If the program finds a file called GOODBYE, it will display that file 
  177.       when the caller exits the program. It will display prior to displaying
  178.       the file called ADOPT.SYS (if you have created it). GOODBYE must reside
  179.       in the same directory as CLASSIFY.EXE
  180.  
  181.  
  182.                            AUTOMATED PURGING
  183.                            -----------------
  184.  
  185.       When you set up the categories to be used in your version of CLASIFIEDS,
  186.       you are asked to define the number of days the ad should remain active.
  187.       By running the CLPURGE program in your nightly event process you will 
  188.       ensure that the ads are deleted, automatically. The following is all 
  189.       that is required to execute the purge:
  190.  
  191.                          CLPURGE CLASSIFY.CFG
  192.                                  ^^^^^^^^^^^^
  193.                                      |
  194.                                      |------ or whatever you call the CFG file
  195.  
  196.        Note: This is only available in registered versions!
  197.  
  198.  
  199.  
  200.                            DATABASE EXCHANGE
  201.                            _________________
  202.  
  203.      
  204.       The optional Classified Ads Database Exchange feature will allow you
  205.       to participate in the exchange of Classified Ads databases with other
  206.       BBS' (Any number of BBS' can participate). The exchange program is 
  207.       named CLEXCH and comes included in the CLASFYxx.ZIP file.
  208.  
  209.       CLEXCH performs two (2) major functions:
  210.  
  211.      (1) EXPORT:  Extracts all active ads from the Classified Ads database. 
  212.                   It creates a file named CLASSIFY.EXP and will bypass any 
  213.                   ad already flagged for deletion.
  214.  
  215.      (2) IMPORT:  Imports the CLASSIFY.EXP file created by the EXPORT option
  216.                   and merges all ads into the Classified Ads database. It will
  217.                   not import any ads that duplicates ads found in the 
  218.                   existing database.
  219.  
  220.      All BBS' involved in the exchange MUST run registered versions of BOTH 
  221.      Classified Ads and Classified Exchange (CLEXCH). CLEXCH will only work 
  222.      with version 1.4 of CLASSIFY or later!
  223.  
  224.      It is critical that ALL participants in the exchange use the SAME 
  225.      Category file. Failure to do so will result in ads meant for a certain
  226.      category on one system, showing up in a category totally unrelated on 
  227.      another system.
  228.  
  229.      To run the Exchange you do the following:
  230.  
  231.      EXPORT:  a) Change to the directory containing your CLASSIFY.DAT file
  232.               b) Issue this command:  CLEXCH EXPORT CLASSIFY.CFG
  233.                  If you use a different name for your Config file, then 
  234.                  substitute that name for CLASSIFY.CFG
  235.               c) Send (transmit) the CLASSIFY.EXP file to those invoved 
  236.                  in the exchange.
  237.               d) Delete CLASSIFY.EXP
  238.  
  239.      IMPORT:  a) Change to the directory containing your CLASSIFY.DAT file
  240.               b) Copy the CLASSIFY.EXP file that was sent to you by the 
  241.                  BBS you are exchanging with, to the directory used in a)
  242.               c) Issue the command:   CLEXCH IMPORT CLASSIFY.CFG
  243.                  If you use a different name for your Config file, then 
  244.                  substitute that name for CLASSIFY.CFG
  245.               d) Delete CLASSIFY.EXP
  246.     
  247.    NOTE: When registering CLEXCH, you MUST use the EXACT SAME Sysop Name
  248.          AND BBS NAME as used for CLASSIFIED ADS!!!!!!!!!!!!!!!!!!!!!!!!!
  249.  
  250.  
  251.                         NON-STANDARD COM SUPPORT
  252.                         ________________________
  253.  
  254.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  255.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  256.       number after the configuration filename. Let's assume your Door is
  257.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  258.       passed to your Door would be:
  259.  
  260.                             FOOBAR FOOBAR.CFG /5
  261.  
  262.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  263.       normally used with COM1. No /x parameter is needed for the standard
  264.       IRQ's.
  265.  
  266.       As an alternative, you may use an environmental variable on the command
  267.       line. To use the variable (following the example above), place a 
  268.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  269.       different IRQ number for each node). The command line would now look 
  270.       like this: 
  271.  
  272.                           FOOBAR FOOBAR.CFG /%IRQ%
  273.       
  274.       This, in combination with the use of the environmental variables 
  275.       described in the MULTI-NODE SETUP section will allow you to use one 
  276.       batch file and one config file to run this door on all nodes.
  277.  
  278.  
  279.  
  280.  
  281.                            MULTI-NODE SETUP
  282.                            ________________
  283.  
  284.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  285.       ability to access a configuration file which will have its own system 
  286.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  287.       line. There are 2 ways to accomplish this:
  288.  
  289.       (1) Create a separate configuration file for each node. The only 
  290.           difference between each file would be the location of the system 
  291.           file for that particular node. For example, on my system there are 2
  292.           nodes and the first line of the config files would look like this:
  293.  
  294.                         NODE1:  H:\PCB1\DOOR.SYS
  295.                         NODE2:  H:\PCB2\DOOR.SYS
  296.  
  297.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  298.  
  299.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  300.           the following PCBoard environmental variables:
  301.  
  302.                  PCBDIR    (Directory containing the System file)
  303.                  PCBDRIVE  (Drive containing the System file)
  304.  
  305.           Thus, the first line of the SINGLE configuration file, for this Door
  306.           would look like this:
  307.  
  308.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  309.  
  310.       NOTE: This option, as described, assumes that you are running PCBoard 
  311.             14.5a software. The environmental variables are automatically 
  312.             created by the software for each node.
  313.  
  314.             HOWEVER, if you are running other BBS software you should be able
  315.             to set the variables EXACTLY as described below, for EACH node 
  316.             (more than likely in each batch file you use to bring up EACH node):
  317.  
  318.                             PCBDRIVE=C:
  319.                             ^^^^^^^^^
  320.                             PCBDIR=\NODE2
  321.                             ^^^^^^^^
  322.             
  323.             Info with a carat (^) under it, MUST be typed as is. The rest 
  324.             depends on your naming conventions. 
  325.  
  326.             This, in combination with the use of the optional environmental
  327.             variable described in the NON-STANDARD COM SUPPORT section, will
  328.             allow you to use one batch file and one config file to run this 
  329.             door on all nodes.
  330.  
  331.  
  332.  
  333.                                ADOPT-A-DOOR
  334.                                ____________
  335.  
  336.     Having been a Sysop for a number of years, I have had my share of problems
  337.     and frustrations getting financial support for my board's upkeep. A fellow
  338.     Sysop left a message on my board, not long ago, about a concept that was
  339.     being used by several boards around the country.
  340.  
  341.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  342.     would be the same as sending in a donation, only this way it is earmarked
  343.     for registering a particular door. In a way, the user feels he/she is
  344.     "getting something in return". As a Door author I have decided to build
  345.     this concept into each of my Door programs. The concept replaces the
  346.     usual message "tell the Sysop to register this Door" we find in most
  347.     doors.
  348.  
  349.     If the Door is unregisterd then a message appears on the opening screen
  350.     to that effect. After finishing or suspending a game, a message screen
  351.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  352.     caller to contact the Sysop to find out if there is any further details
  353.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  354.     time, etc to callers that ADOPT-A-DOOR.
  355.  
  356.     If the Door has been registered, either by the Sysop or other callers,
  357.     the names of those contributors will be displayed in the closing screen.
  358.  
  359.     NOTE: If you want to display the names of the callers that contributed
  360.           to registering the Door, you must create an ASCII file called
  361.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  362.           the name(s) of the contributors (one on each line, maximum of 5
  363.           entries, each a maximum of 30 characters long). This file must be
  364.           saved, in ASCII format, and placed in the Door directory.
  365.  
  366.  
  367.  
  368.                               LEGALITIES
  369.                               __________
  370.  
  371.  
  372.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  373.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  374.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  375.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  376.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  377.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  378.       OR BREACH OF ANY WARRANTY.
  379.  
  380.  
  381.  
  382.  
  383.  
  384.                              DISTRIBUTION
  385.                              ____________
  386.  
  387.    You may make this file available for downloading from your BBS or you may
  388.    upload it to any BBS of your choice, provided that you do not make any
  389.    changes to the contents of the archive (ZIP file). The archive and its
  390.    individual contents may not be used by any service that charges any money
  391.    whatsoever, without the written permission of the author.
  392.  
  393.  
  394.  
  395.  
  396.  
  397.                              REGISTRATION
  398.                              ____________
  399.  
  400.    Registration and the subsequent insertion of the registration number into
  401.    your configuation file, allows for the display of your BBS name on the
  402.    opening and closing screen as well as the reduction of a delay built into
  403.    the opening screen display along with the ability to change certain
  404.    values in the configuration file.
  405.  
  406.    To register your copy of CLASSIFY, please fill out the registration form
  407.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  408.    the name and address on the form.
  409.  
  410.    Be sure to use the proper upper/lower case when filling in your name and
  411.    BBS name, as they MUST match the way you entered them in the configuration
  412.    file.             ^^^^
  413.  
  414.    Based upon information supplied on the registration form, I will pre-
  415.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  416.    up your registration number.
  417.  
  418.  
  419.  
  420.                                  MISC
  421.                                  ____
  422.  
  423.    The latest version of CLASSIFIED ADS and other fine SUNRISE DOOR programs
  424.    are always available for download from SUNRISE-80 BBS.
  425.  
  426.    Remember, should you have any problems, questions or suggestions, be sure
  427.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  428.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  429.